Class: Application
- Inherits:
-
Object
- Object
- Application
- Includes:
- Mongoid::Document, Mongoid::Timestamps, UtilHelper
- Defined in:
- origin-server/controller/app/models/application.rb
Overview
Class to represent an OpenShift Application
Constant Summary
- APP_NAME_MAX_LENGTH =
Maximum length of a valid application name
32- MAX_SCALE =
Numeric representation for unlimited scaling
-1- APP_NAME_REGEX =
This is the current regex for validations for new applications
/\A[A-Za-z0-9]+\z/- APP_NAME_COMPATIBILITY_REGEX =
This is the regex that ensures backward compatibility for fetches
APP_NAME_REGEX
Instance Attribute Summary (collapse)
-
- (Array<String>) aliases
readonly
Array of DNS aliases registered with this application.
-
- (Hash) analytics
readonly
Location to store analytics data relevant to the application.
-
- (Array<ApplicationSshKey>) app_ssh_keys
readonly
Array of auto-generated SSH keys used by components of the application to connect to other gears.
-
- (String) canonical_name
readonly
The down-cased name of the application.
-
- (Array<ComponentInstance>) component_instances
readonly
Array of components in this application.
-
- (Array<String>) component_start_order
Normally start order computed based on order specified by each component’s manifest.
-
- (Array<String>) component_stop_order
Normally configure order computed based on order specified by each component’s manifest.
- - (Object) connections
-
- (String) default_gear_size
readonly
The default gear size to use when creating a new GroupInstance.
-
- (Domain) domain
readonly
Domain that this application is part of.
-
- (Array<String>) domain_requires
Array of IDs of the applications that this application is dependent on If the parent application is destroyed, this application also needs to be destroyed.
- - (Object) downloaded_cartridges
-
- (Array<GroupInstance>) group_instances
readonly
Array of gear groups in the application.
-
- (Array<Array<String>>) group_overrides
Array of Array of components that need to be co-located.
-
- (String) init_git_url
readonly
Stores the URL to the GIT url specified during application creation.
-
- (String) name
The name of the application.
-
- (Array<PendingAppOpGroup>) pending_op_groups
List of pending operations to be performed on this application.
-
- (Boolean) scalable
readonly
This value is true if the application is scalable.
-
- (Object) user_agent
non-persisted field used to store user agent of current request.
-
- (Array<Moped::BSON::ObjectId>) user_ids
readonly
Array of IDs of users that have access to this application.
-
- (String) uuid
readonly
UUID that represents this application.
Class Method Summary (collapse)
-
+ (Application) create_app(application_name, features, domain, default_gear_size = nil, scalable = false, result_io = ResultIO.new, group_overrides = [], init_git_url = nil, user_agent = nil, community_cart_urls = [])
Factory method to create the Application.
-
+ (Application?) find(user, app_name)
Helper method to find an application using the application name.
-
+ ([Application,Gear]) find_by_gear_uuid(gear_uuid)
Helper method to find an application that runs on a particular gear.
- + (Object) run_in_application_lock(application, &block)
-
+ (Object) validation_map
Returns a map of field to error code for validation failures
- 105: Invalid application name.
Instance Method Summary (collapse)
-
- (Object) add_alias(fqdn, ssl_certificate = nil, private_key = nil, pass_phrase = "")
Register a DNS alias for the application.
- - (Object) add_component_ops(op_type, component_instance, ops)
-
- (ResultIO) add_env_variables(vars, parent_op = nil)
Adds environment variables to all gears on the application.
-
- (ResultIO) add_features(features, group_overrides = [], init_git_url = nil)
Adds components to the application.
-
- (ResultIO) add_ssh_keys(user_id, keys, parent_op)
Adds the given ssh key to the application.
- - (Object) calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url = nil)
-
- (Object) calculate_component_orders
Returns the start/stop order specified in the application descriptor or processes the start and stop orders for each component and returns the final order (topological sort).
-
- (Object) calculate_configure_order(comp_specs)
Returns the configure order specified in the application descriptor or processes the configure orders for each component and returns the final order (topological sort).
- - (Object) calculate_ctl_app_component_ops(op_type)
- - (Object) calculate_ctl_component_ops(op_type, comp_spec)
- - (Object) calculate_ctl_feature_component_ops(op_type, feature)
- - (Object) calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id = nil, is_scale_up = false, hosts_app_dns = false, init_git_url = nil)
- - (Object) calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb)
-
- (Object) calculate_ops(changes, moves = [], connections = nil, group_overrides = nil, init_git_url = nil)
Given a set of changes, moves and connections, calculates all the operations required to update the application.
- - (Object) calculate_remove_component_ops(comp_specs, group_instance, singleton_gear)
- - (Object) calculate_remove_gear_ops(args, prereqs = {})
- - (Object) calculate_remove_group_instance_ops(comp_specs, group_instance)
- - (Object) calculate_replace_all_ssh_keys_ops(args)
- - (Object) calculate_scale_by(ginst_id, scale_by)
- - (Object) calculate_update_existing_configuration_ops(args, prereqs = {})
- - (Object) calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs)
- - (Object) component_status(component_instance)
-
- (Object) compute_diffs(current_group_instances, new_group_instances)
Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to a new set.
-
- (ResultIO) destroy_app
Destroys all gears on the application.
-
- (Object) elaborate(features, group_overrides = [])
Computes the group instances, component instances and connections required to support a given set of features.
- - (Object) execute_connections
-
- (Object) extended_validator
Observer hook for extending the validation of the application in an ActiveRecord::Observer.
-
- (ResultIO) fix_gear_ssh_keys
Removes all ssh keys from the application’s gears and adds the given ssh keys.
-
- (String) fqdn(domain = nil, gear_uuid = nil)
Returns the fully qualified DNS name for the primary application gear.
- - (Object) gen_non_scalable_app_overrides(features)
-
- (Integer) get_app_scaling_limits
Get scaling limits for the application’s group instance that has the web framework cartridge This method is only to maintain backwards compatibility for rest api version 1.0.
- - (Object) get_components_for_feature(feature)
-
- (Object) get_feature(cartridge_name, component_name)
Gets a feature name for the cartridge/component combination.
-
- (Object) get_framework_cartridge
Get the web framework cartridge This method is only to maintain backwards compatibility for rest api version 1.0.
-
- (Hash<String, String>) get_gear_states
Retrieves the gear state for all gears within the application.
- - (Object) get_unsubscribe_info(comp_inst)
-
- (Object) get_updated_ssh_keys(user_id, keys)
The ssh key names are used as part of the ssh key comments on the application’s gears Do not change the format of the key name, otherwise it may break key removal code on the node.
-
- (Array<GroupInstance>) group_instances_with_scale
Retrieve the list of GroupInstance objects along with min and max gear specifications from group overrides.
-
- (String) health_check_path
Get path for checking application health This method is only to maintain backwards compatibility for rest api version 1.0.
-
- (Application) initialize(attrs = nil, options = nil)
constructor
Constructor.
- - (Object) merge_group_overrides(first, second)
-
- (Integer) num_gears
Returns the total number of gears currently used by this application.
- - (Object) op_type_to_comp_op_type(op_type)
-
- (Object) process_commands(result_io, component_id = nil)
Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc
Parameters:
result_io::.
- - (Object) process_group_overrides(component_instances, group_overrides)
- - (Object) quarantined
- - (Object) reload_component_config(component_name, cartridge_name)
- - (Object) reload_config(feature = nil)
-
- (Object) remove_alias(fqdn)
Removes a DNS alias for the application.
-
- (ResultIO) remove_env_variables(vars, parent_op = nil)
Remove environment variables from all gears on the application.
-
- (ResultIO) remove_features(features, group_overrides = [], force = false)
Removes components from the application.
- - (Object) remove_gear(gear_uuid)
-
- (ResultIO) remove_ssh_keys(user_id, keys, parent_op = nil)
Remove the given ssh key from the application.
-
- (Array<String>) requires(include_pending = false)
Returns the feature requirements of the application.
- - (Object) restart(feature = nil)
- - (Object) restart_component(component_name, cartridge_name)
-
- (Object) run_jobs(result_io = nil)
Acquires an application level lock and runs all pending jobs and stops at the first failure.
-
- (ResultIO) scale_by(group_instance_id, scale_by)
Trigger a scale up or scale down of a GroupInstance.
- - (Object) set_connections(connections)
-
- (ResultIO) set_group_overrides(group_overrides)
Updates the component grouping overrides of the application and create tasks to perform the update.
- - (Object) show_port
-
- (String) ssh_uri(domain = nil, gear_uuid = nil)
Returns the SSH URI for the primary application gear.
-
- (ResultIO) start(feature = nil)
Start an application of feature.
- - (Object) start_component(component_name, cartridge_name)
- - (Object) status(feature = nil)
- - (Object) stop(feature = nil, force = false)
- - (Object) stop_component(component_name, cartridge_name, force = false)
- - (Object) threaddump
- - (Object) tidy
-
- (Object) to_descriptor
Returns the application descriptor as a Hash.
-
- (Object) try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops)
Persists change operation only if the additional number of gears requested are available on the domain owner.
- - (Object) unreserve_gears(num_gears_removed)
- - (Object) unsubscribe_connections(sub_pub_hash)
- - (Object) update_alias(fqdn, ssl_certificate = nil, private_key = nil, pass_phrase = "")
-
- (ResultIO) update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb)
Create and add group overrides to update scaling and filesystem limits for a the GroupInstance hosting a ComponentInstance.
- - (Object) update_requirements(features, group_overrides, init_git_url = nil)
- - (Object) validate_certificate(ssl_certificate, private_key, pass_phrase)
Methods included from UtilHelper
Constructor Details
- (Application) initialize(attrs = nil, options = nil)
side-effect: Saves application object in mongo
Constructor. Should not be used directly. Use #create_app instead.
251 252 253 254 255 256 257 258 259 |
# File 'origin-server/controller/app/models/application.rb', line 251 def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end |
Instance Attribute Details
- (Array<String>) aliases (readonly)
Array of DNS aliases registered with this application. @see #add_alias and #remove_alias
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Hash) analytics (readonly)
Location to store analytics data relevant to the application
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Array<ApplicationSshKey>) app_ssh_keys (readonly)
Array of auto-generated SSH keys used by components of the application to connect to other gears
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (String) canonical_name (readonly)
The down-cased name of the application
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Array<ComponentInstance>) component_instances (readonly)
Array of components in this application
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Array<String>) component_start_order
Normally start order computed based on order specified by each component’s manifest. This attribute is used to overrides the start order
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Array<String>) component_stop_order
Normally configure order computed based on order specified by each component’s manifest. This attribute is used to overrides the configure order
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Object) connections
104 105 106 |
# File 'origin-server/controller/app/models/application.rb', line 104 def connections @connections end |
- (String) default_gear_size (readonly)
The default gear size to use when creating a new GroupInstance. This value can be overridden using group overrides or in the cartridge manifest
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Domain) domain (readonly)
Domain that this application is part of.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Array<String>) domain_requires
Array of IDs of the applications that this application is dependent on If the parent application is destroyed, this application also needs to be destroyed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Object) downloaded_cartridges
103 104 105 |
# File 'origin-server/controller/app/models/application.rb', line 103 def downloaded_cartridges @downloaded_cartridges end |
- (Array<GroupInstance>) group_instances (readonly)
Array of gear groups in the application
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Array<Array<String>>) group_overrides
Array of Array of components that need to be co-located
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (String) init_git_url (readonly)
Stores the URL to the GIT url specified during application creation
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (String) name
The name of the application. The name of the application is user provided and can be mixed case
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Array<PendingAppOpGroup>) pending_op_groups
List of pending operations to be performed on this application
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Boolean) scalable (readonly)
This value is true if the application is scalable
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Object) user_agent
non-persisted field used to store user agent of current request
102 103 104 |
# File 'origin-server/controller/app/models/application.rb', line 102 def user_agent @user_agent end |
- (Array<Moped::BSON::ObjectId>) user_ids (readonly)
Array of IDs of users that have access to this application.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (String) uuid (readonly)
UUID that represents this application. This is usually the same as the MongoID ID field. For applications that existed before the transition to MongoID, this field represents the original UUID and will differ from the MongoID ID field.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 58 class Application include Mongoid::Document include Mongoid::Timestamps include UtilHelper # Maximum length of a valid application name APP_NAME_MAX_LENGTH = 32 # Numeric representation for unlimited scaling MAX_SCALE = -1 # This is the current regex for validations for new applications APP_NAME_REGEX = /\A[A-Za-z0-9]+\z/ # This is the regex that ensures backward compatibility for fetches APP_NAME_COMPATIBILITY_REGEX = APP_NAME_REGEX field :name, type: String field :canonical_name, type: String field :uuid, type: String, default: "" field :domain_requires, type: Array, default: [] field :group_overrides, type: Array, default: [] :pending_op_groups, class_name: PendingAppOpGroup.name belongs_to :domain field :downloaded_cart_map, type: Hash, default: {} field :user_ids, type: Array, default: [] field :component_start_order, type: Array, default: [] field :component_stop_order, type: Array, default: [] field :component_configure_order, type: Array, default: [] field :default_gear_size, type: String field :scalable, type: Boolean, default: false field :init_git_url, type: String, default: "" field :analytics, type: Hash, default: {} :component_instances, class_name: ComponentInstance.name :group_instances, class_name: GroupInstance.name :app_ssh_keys, class_name: ApplicationSshKey.name :aliases, class_name: Alias.name index({'group_instances.gears.uuid' => 1}, {:unique => true, :sparse => true}) index({'domain_id' => 1}) create_indexes # non-persisted field used to store user agent of current request attr_accessor :user_agent attr_accessor :downloaded_cartridges attr_accessor :connections validates :name, presence: {: "Application name is required and cannot be blank."}, format: {with: APP_NAME_REGEX, : "Invalid application name. Name must only contain alphanumeric characters."}, length: {maximum: APP_NAME_MAX_LENGTH, minimum: 1, : "Application name must be a minimum of 1 and maximum of #{APP_NAME_MAX_LENGTH} characters."}, blacklisted: {: "Application name is not allowed. Please choose another."} validate :extended_validator # Returns a map of field to error code for validation failures # * 105: Invalid application name def self.validation_map {name: 105} end # Hook to prevent accidental deletion of MongoID model before all related {Gear}s are removed before_destroy do |app| raise "Please call destroy_app to delete all gears before deleting this application" if num_gears > 0 end # Observer hook for extending the validation of the application in an ActiveRecord::Observer # @see http://api.rubyonrails.org/classes/ActiveRecord/Observer.html def extended_validator notify_observers(:validate_application) end ## # Factory method to create the {Application} # # @param application_name [String] Name of the application # @param features [Array<String>] List of cartridges or features to add to the application # @param domain [Domain] The domain namespace under which this application is created # @param default_gear_size [String] The default gear size to use when creating a new {Gear} for the application # @param scalable [Boolean] Indicates if the application should be scalable or host all cartridges on a single gear. # If set to true, a "web_proxy" cartridge is automatically added to perform load-balancing for the web tier # @param result_io [ResultIO, #output] Object to log all messages and cartridge output # @param group_overrides [Array] List of overrides to specify gear sizes, scaling limits, component colocation etc. # @param init_git_url [String] URL to git repository to retrieve application code # @param user_agent [String] user agent string of browser used for this rest API request # @return [Application] Application object # @raise [OpenShift::ApplicationValidationException] Exception to indicate a validation error def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end def downloaded_cartridges cmap = self.downloaded_cart_map return @downloaded_cartridges if @downloaded_cartridges and cmap.length==@downloaded_cartridges.length # download the content of the url # careful, but assume this to be manifest.yml # parse the manifest and store the cartridge begin @downloaded_cartridges = {} cmap.each { |cartname, cartdata| manifest_str = cartdata["original_manifest"] CartridgeCache.foreach_cart_version(manifest_str, cartdata["version"]) do |chash,name,version,vendored_name| cart = OpenShift::Cartridge.new.from_descriptor(chash) if @downloaded_cartridges.has_key?(cart.name) Rails.logger.error("Duplicate community cartridge exists for application '#{self.name}'! Overwriting..") end @downloaded_cartridges[cart.name] = cart end } rescue Exception =>e Rails.logger.error(e.) raise e end @downloaded_cartridges end ## # Helper method to find an application using the application name # @param user [CloudUser] The owner of the application # @param app_name [String] The application name # @return [Application, nil] The application object or nil if no application matches def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end ## # Helper method to find an application that runs on a particular gear # @param gear_uuid [String] The UUID of the gear # @return [[Application,Gear]] The application and gear objects or nil array if no application matches def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end ## # Constructor. Should not be used directly. Use {Application#create_app} instead. # @note side-effect: Saves application object in mongo def initialize(attrs = nil, = nil) super @downloaded_cartridges = {} self.uuid = self._id.to_s if self.uuid=="" or self.uuid.nil? self.app_ssh_keys = [] self.pending_op_groups = [] self.analytics = {} if self.analytics.nil? self.save end ## # Setter for application name. Sets both the name and the canonical_name for the application # @param app_name [String] The application name def name=(app_name) self.canonical_name = app_name.downcase super end ## # Adds the given ssh key to the application. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed # but application access will still be possible. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to remove from the application. # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Removes all ssh keys from the application's gears and adds the given ssh keys. # @param user_id [String] The ID of the user associated with the keys. If the user ID is nil, then the key is assumed to be a system generated key # @param keys [Array<SshKey>] Array of keys to add to the application. # @return [ResultIO] Output from cartridges def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Adds environment variables to all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Remove environment variables from all gears on the application. # @param vars [Array<Hash>] List of environment variables. Each entry must contain key and value # @param parent_op [PendingDomainOps] object used to track this operation at a domain level # @return [ResultIO] Output from cartridges def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the total number of gears currently used by this application # @return [Integer] number of gears def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end ## # Retrieve the list of {GroupInstance} objects along with min and max gear specifications from group overrides # @return [Array<GroupInstance>] def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end ## # Returns the feature requirements of the application # @param include_pending [Boolean] Include the pending changes when calculating the list of features # @return [Array<String>] List of features def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end ## # Adds components to the application # @param features [Array<String>] List of features to add to the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param init_git_url [String] URL to git repository to retrieve application code # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be added into the Application def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Removes components from the application # @param features [Array<String>] List of features to remove from the application. Each feature will be resolved to the cartridge which provides it # @param group_overrides [Array] List of group overrides # @param force [Boolean] Set to true when deleting an application. It allows removal of web_proxy and ignores missing features # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if there is any reason the feature/cartridge cannot be removed from the Application def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end ## # Destroys all gears on the application. # @note {#run_jobs} must be called in order to perform the updates # This operation will trigger deletion of any applications listed in {#domain_requires} # @return [ResultIO] Output from cartridges def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Updates the component grouping overrides of the application and create tasks to perform the update # @param group_overrides [Array] list of group overrides # @return [ResultIO] Output from cartridges def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Create and add group overrides to update scaling and filesystem limits for a the {GroupInstance} hosting a {ComponentInstance} # @param component_instance [ComponentInstance] The component instance to use when creating the override definition # @param scale_from [Integer] Minimum scale for the component # @param scale_to [Integer] Maximum scale for the component # @param additional_filesystem_gb [Integer] Gb of disk storage required beyond is default in the gear size # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Trigger a scale up or scale down of a {GroupInstance} # @param group_instance_id [String] ID of the {GroupInstance} # @param scale_by [Integer] Number of gears to scale add/remove from the {GroupInstance}. # A postive value will trigger a scale up and a negative value a scale down # @return [ResultIO] Output from cartridges # @raise [OpenShift::UserException] Exception raised if request cannot be completed def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end ## # Returns the fully qualified DNS name for the primary application gear # @return [String] def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end ## # Returns the SSH URI for the primary application gear # @return [String] def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end ## # Retrieves the gear state for all gears within the application. # @return [Hash<String, String>] Map of {Gear} ID to state def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end ## # Returns the application descriptor as a Hash. The descriptor contains all the metadata # necessary to descript the application. # @requires [Hash] def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end ## # Start an application of feature # @param feature [String, #optional] Optional feature name to start. If nil, it will trigger start on all features in the application # @return [ResultIO] Output from cartridges def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end def show_port #TODO raise "noimpl" end def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end # Register a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to associate with this application # ssl_certificate:: SSL certificate to add # private_key::Private key for the SSL certificate # pass_phrase::Optional passphrase for the private key # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. # # == Raises: # OpenShift::UserException if the alias is already been associated with an application. def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end # Removes a DNS alias for the application. # # == Parameters: # fqdn:: # Fully qualified domain name of the alias to remove from this application # # == Returns: # {PendingAppOps} object which tracks the progress of the operation. def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end #private # Processes directives returned by component hooks to add/remove domain ssh keys, app ssh keys, env variables, broker keys etc # @note {#run_jobs} must be called in order to perform the updates # # == Parameters: # result_io:: # {ResultIO} object with directives from cartridge hooks def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end # Acquires an application level lock and runs all pending jobs and stops at the first failure. # # == Returns: # True on success or False if unable to acquire the lock or no pending jobs. def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end # Given a set of changes, moves and connections, calculates all the operations required to update the application. # # == Parameters: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of {#compute_diffs} or {#scale_by}) # # moves:: # A list of components which need to move from one group instance to another. (Output of {#compute_diffs}) # # connections:: # An array of connections. (Output of {#elaborate}) def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end # Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to # a new set. # # == Parameters: # current_group_instances:: # Group instance list containing information about current group instances. Expected format: # [ {component_instances: [{cart: <cart name>, comp: <comp name>}...], _id: <uuid>, scale: {min: <min scale>, max: <max scale>, current: <current scale>}}...] # new_group_instances:: # New set of group instances as computed by the elaborate function # # == Returns: # changes:: # Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) # moves:: # A list of components which need to move from one group instance to another def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end # Persists change operation only if the additional number of gears requested are available on the domain owner # # == Parameters: # num_gears:: # Number of gears to add or remove # # ops:: # Array of pending operations. # @see {PendingAppOps} def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end # Computes the group instances, component instances and connections required to support a given set of features # # == Parameters: # feature:: # A list of features # group_overrides:: # A list of group-overrides which specify which components must be placed on the same group. # Components can be specified as Hash{cart: <cart name> [, comp: <component name>]} # # == Returns: # connections:: # An array of connections # group instances:: # An array of hash values representing a group instances. def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
Class Method Details
+ (Application) create_app(application_name, features, domain, default_gear_size = nil, scalable = false, result_io = ResultIO.new, group_overrides = [], init_git_url = nil, user_agent = nil, community_cart_urls = [])
Factory method to create the Application
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'origin-server/controller/app/models/application.rb', line 145 def self.create_app(application_name, features, domain, default_gear_size = nil, scalable=false, result_io=ResultIO.new, group_overrides=[], init_git_url=nil, user_agent=nil, community_cart_urls=[]) default_gear_size = Rails.application.config.openshift[:default_gear_size] if default_gear_size.nil? cmap = CartridgeCache.fetch_community_carts(community_cart_urls) app = Application.new(domain: domain, name: application_name, default_gear_size: default_gear_size, scalable: scalable, app_ssh_keys: [], pending_op_groups: [], init_git_url: init_git_url, downloaded_cart_map: cmap) app.user_agent = user_agent app.analytics['user_agent'] = user_agent app.save features << "web_proxy" if scalable if app.valid? begin app.downloaded_cartridges.each { |cname,c| features << c.name } framework_carts = CartridgeCache.cartridge_names("web_framework", app) framework_cartridges = [] features.each do |feature| cart = CartridgeCache.find_cartridge(feature, app) if cart framework_cartridges.push(cart.name) if framework_carts.include?(feature) else raise OpenShift::UserException.new("Invalid cartridge '#{feature}' specified.", 109, "cartridge") end end if framework_carts.empty? raise OpenShift::UserException.new("Unable to determine list of available cartridges. If the problem persists please contact Red Hat support", 109, "cartridge") elsif framework_cartridges.empty? raise OpenShift::UserException.new("Each application must contain one web cartridge. None of the specified cartridges #{features.to_sentence} is a web cartridge. Please include one of the following cartridges: #{framework_carts.to_sentence} or supply a valid url to a custom web_framework cartridge.", 109, "cartridge") elsif framework_cartridges.length > 1 raise OpenShift::UserException.new("Each application must contain only one web cartridge. Please include a single web cartridge from this list: #{framework_carts.to_sentence}.", 109, "cartridge") end add_feature_result = app.add_features(features, group_overrides, init_git_url) result_io.append add_feature_result rescue Exception => e if (app.group_instances.nil? or app.group_instances.empty?) and (app.component_instances.nil? or app.component_instances.empty?) app.delete end raise e end app else app.delete raise OpenShift::ApplicationValidationException.new(app) end app end |
+ (Application?) find(user, app_name)
Helper method to find an application using the application name
230 231 232 233 |
# File 'origin-server/controller/app/models/application.rb', line 230 def self.find(user, app_name) user.domains.each { |d| d.applications.each { |a| return a if a.canonical_name == app_name.downcase } } return nil end |
+ ([Application,Gear]) find_by_gear_uuid(gear_uuid)
Helper method to find an application that runs on a particular gear
239 240 241 242 243 244 245 246 |
# File 'origin-server/controller/app/models/application.rb', line 239 def self.find_by_gear_uuid(gear_uuid) # obj_id = Moped::BSON::ObjectId(gear_uuid) obj_id = gear_uuid.to_s app = Application.where("group_instances.gears.uuid" => obj_id).first return [nil, nil] if app.nil? gear = app.group_instances.map { |gi| gi.gears.select { |g| g.uuid== obj_id } }.flatten[0] return [app, gear] end |
+ (Object) run_in_application_lock(application, &block)
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 |
# File 'origin-server/controller/app/models/application.rb', line 1255 def self.run_in_application_lock(application, &block) got_lock = false num_retries = 10 wait = 5 while(num_retries > 0 and !got_lock) if(Lock.lock_application(application)) got_lock = true else num_retries -= 1 sleep(wait) end end if got_lock begin yield block ensure Lock.unlock_application(application) end else raise OpenShift::LockUnavailableException.new("Unable to perform action. Another operation is already running.", 171) end end |
+ (Object) validation_map
Returns a map of field to error code for validation failures
- 105: Invalid application name
115 116 117 |
# File 'origin-server/controller/app/models/application.rb', line 115 def self.validation_map {name: 105} end |
Instance Method Details
- (Object) add_alias(fqdn, ssl_certificate = nil, private_key = nil, pass_phrase = "")
Register a DNS alias for the application.
Parameters:
| fqdn: | Fully qualified domain name of the alias to associate with this application |
| ssl_certificate: | SSL certificate to add |
private_key::Private key for the SSL certificate pass_phrase::Optional passphrase for the private key
Returns:
PendingAppOps object which tracks the progress of the operation.
Raises:
OpenShift::UserException if the alias is already been associated with an application.
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'origin-server/controller/app/models/application.rb', line 852 def add_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") # Server aliases validate as DNS host names in accordance with RFC # 1123 and RFC 952. Additionally, OpenShift does not allow an # Alias to be an IP address or a host in the service domain. # Since DNS is case insensitive, all names are downcased for # indexing/compares. server_alias = fqdn.downcase if fqdn if !(server_alias =~ /\A[0-9a-zA-Z\-\.]+\z/) or (server_alias =~ /#{Rails.configuration.openshift[:domain_suffix]}$/) or (server_alias.length > 255 ) or (server_alias.length == 0 ) or (server_alias.nil?) or (server_alias =~ /^\d+\.\d+\.\d+\.\d+$/) or (server_alias =~ /\A[\S]+(\.(json|xml|yml|yaml|html|xhtml))\z/) raise OpenShift::UserException.new("Invalid Server Alias '#{server_alias}' specified", 105) end validate_certificate(ssl_certificate, private_key, pass_phrase) Application.run_in_application_lock(self) do raise OpenShift::UserException.new("Alias #{server_alias} is already registered", 140) if Application.where("aliases.fqdn" => server_alias).count > 0 op_group = PendingAppOpGroup.new(op_type: :add_alias, args: {"fqdn" => server_alias}, user_agent: self.user_agent) self.pending_op_groups.push op_group if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => server_alias, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Object) add_component_ops(op_type, component_instance, ops)
1587 1588 1589 1590 1591 1592 1593 1594 1595 |
# File 'origin-server/controller/app/models/application.rb', line 1587 def add_component_ops(op_type, component_instance, ops) count = 0 component_instance.group_instance.gears.each do |gear| break if component_instance.is_singleton? and count > 0 count += 1 op = PendingAppOp.new(op_type: op_type, args: {'group_instance_id' => component_instance.group_instance._id, 'gear_id' => gear._id, 'comp_spec' => {'cart' => component_instance.cartridge_name, 'comp' => component_instance.component_name}}) ops.push op end end |
- (ResultIO) add_env_variables(vars, parent_op = nil)
Adds environment variables to all gears on the application.
340 341 342 343 344 345 346 347 348 |
# File 'origin-server/controller/app/models/application.rb', line 340 def add_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (ResultIO) add_features(features, group_overrides = [], init_git_url = nil)
Adds components to the application
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
# File 'origin-server/controller/app/models/application.rb', line 414 def add_features(features, group_overrides=[], init_git_url=nil) features.each do |feature_name| cart = CartridgeCache.find_cartridge(feature_name, self) # Make sure this is a valid cartridge if cart.nil? raise OpenShift::UserException.new("Invalid cartridge '#{feature_name}' specified.", 109) end if cart.is_web_framework? component_instances.each do |ci| if ci.is_web_framework? raise OpenShift::UserException.new("You can only have one framework cartridge in your application '#{name}'.", 109) end end end # Validate that the features support scalable if necessary if self.scalable && !(cart.is_plugin? || cart.is_service?) if cart.is_web_framework? raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) else raise OpenShift::UserException.new("#{feature_name} cannot be embedded in scalable app '#{name}'.", 109) end end # prevent a proxy from being added to a non-scalable (single-gear) application if cart.is_web_proxy? and !self.scalable raise OpenShift::UserException.new("#{feature_name} cannot be added to existing applications. It is automatically added when you create a scaling application.", 137) end if self.scalable and cart.is_web_framework? prof = cart.profile_for_feature(feature_name) cart_scalable = false prof.components.each do |component| next if component.scaling.min==1 and component.scaling.max==1 cart_scalable = true end if !cart_scalable raise OpenShift::UserException.new("Scalable app cannot be of type '#{feature_name}'.", 109) end end # Validate that this feature either does not have the domain_scope category # or if it does, then no other application within the domain has this feature already if cart.is_domain_scoped? begin if Application.where(domain_id: self.domain._id, "component_instances.cartridge_name" => cart.name).count() > 0 raise .new("An application with #{feature_name} already exists within the domain. You can only have a single application with #{feature_name} within a domain.") end rescue Mongoid::Errors::DocumentNotFound #ignore end end end result_io = ResultIO.new Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :add_features, args: {"features" => features, "group_overrides" => group_overrides, "init_git_url"=>init_git_url}, user_agent: self.user_agent) self.run_jobs(result_io) end # adding this feature may have caused pending_ops to be created on the domain # for adding env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end |
- (ResultIO) add_ssh_keys(user_id, keys, parent_op)
Adds the given ssh key to the application.
275 276 277 278 279 280 281 282 283 284 285 |
# File 'origin-server/controller/app/models/application.rb', line 275 def add_ssh_keys(user_id, keys, parent_op) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Object) calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url = nil)
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'origin-server/controller/app/models/application.rb', line 1482 def calculate_add_component_ops(comp_specs, group_instance_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, new_group_instance_op_id, init_git_url=nil) ops = [] comp_specs.each do |comp_spec| component_ops[comp_spec] = {new_component: nil, adds: [], post_configures: []} if component_ops[comp_spec].nil? cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) is_singleton = cartridge.get_component(comp_spec["comp"]).is_singleton? new_component_op_id = [] unless is_scale_up new_component_op = PendingAppOp.new(op_type: :new_component, args: {"group_instance_id"=> group_instance_id, "comp_spec" => comp_spec, "cartridge_vendor" => cartridge.cartridge_vendor, "version" => cartridge.version}, prereq: [new_group_instance_op_id]) component_ops[comp_spec][:new_component] = new_component_op new_component_op_id = [new_component_op._id.to_s] ops.push new_component_op end if is_singleton if gear_id_prereqs.keys.include?(singleton_gear_id) prereq_id = gear_id_prereqs[singleton_gear_id] git_url = nil git_url = init_git_url if cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] # if its a singleton, then it cannot be a scaleup, # hence no need to check whether its a deployable cart and scaleup case post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => singleton_gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end else gear_id_prereqs.each do |gear_id, prereq_id| git_url = nil git_url = init_git_url if gear_id == singleton_gear_id && cartridge.is_deployable? add_component_op = PendingAppOp.new(op_type: :add_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: new_component_op_id + [prereq_id]) ops.push add_component_op component_ops[comp_spec][:adds].push add_component_op usage_op_prereq = [add_component_op._id.to_s] unless is_scale_up and cartridge.is_deployable? post_configure_op = PendingAppOp.new(op_type: :post_configure_component, args: {"group_instance_id"=> group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec, "init_git_url" => git_url}, prereq: [add_component_op._id.to_s] + [prereq_id]) ops.push post_configure_op component_ops[comp_spec][:post_configures].push post_configure_op usage_op_prereq = [post_configure_op._id.to_s] end ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: usage_op_prereq)) if cartridge.is_premium? end end end if self.scalable last_op = ops.last expose_prereqs = [] expose_prereqs << last_op._id.to_s unless last_op.nil? comp_specs.each do |comp_spec| gear_id_prereqs.each do |gear_id, prereq_id| op = PendingAppOp.new(op_type: :expose_port, args: { "group_instance_id" => group_instance_id, "gear_id" => gear_id, "comp_spec" => comp_spec }, prereq: expose_prereqs + [prereq_id]) ops.push op end end end ops end |
- (Object) calculate_component_orders
Returns the start/stop order specified in the application descriptor or processes the start and stop orders for each component and returns the final order (topological sort).
Returns:
| start_order: | ComponentInstance objects ordered by calculated start order |
| stop_order: | ComponentInstance objects ordered by calculated stop order |
2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 |
# File 'origin-server/controller/app/models/application.rb', line 2207 def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end |
- (Object) calculate_configure_order(comp_specs)
This is calculates separately from start/stop order as this function is usually used to compute the PendingAppOps while start/stop order applies to already configured components.
Returns the configure order specified in the application descriptor or processes the configure orders for each component and returns the final order (topological sort).
Parameters:
| comp_specs: | Array of components specs to order. |
Returns:
ComponentInstance objects ordered by calculated configure order
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 |
# File 'origin-server/controller/app/models/application.rb', line 2164 def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end |
- (Object) calculate_ctl_app_component_ops(op_type)
1564 1565 1566 1567 1568 1569 1570 1571 1572 |
# File 'origin-server/controller/app/models/application.rb', line 1564 def calculate_ctl_app_component_ops(op_type) ops = [] start_order, stop_order = calculate_component_orders order = (op_type == :stop_app) ? stop_order : start_order order.each do |component_instance| add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end ops end |
- (Object) calculate_ctl_component_ops(op_type, comp_spec)
1557 1558 1559 1560 1561 1562 |
# File 'origin-server/controller/app/models/application.rb', line 1557 def calculate_ctl_component_ops(op_type, comp_spec) component_instance = self.component_instances.find_by(cartridge_name: comp_spec['cart'], component_name: comp_spec['comp']) ops = [] add_component_ops(op_type, component_instance, ops) ops end |
- (Object) calculate_ctl_feature_component_ops(op_type, feature)
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'origin-server/controller/app/models/application.rb', line 1574 def calculate_ctl_feature_component_ops(op_type, feature) ops = [] component_instances = get_components_for_feature(feature) start_order, stop_order = calculate_component_orders order = op_type == :stop_feature ? stop_order : start_order order.each do |component_instance| if component_instances.include? component_instance add_component_ops(op_type_to_comp_op_type(op_type), component_instance, ops) end end ops end |
- (Object) calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id = nil, is_scale_up = false, hosts_app_dns = false, init_git_url = nil)
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 |
# File 'origin-server/controller/app/models/application.rb', line 1395 def calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op_id=nil, is_scale_up=false, hosts_app_dns=false, init_git_url=nil) pending_ops = [] a_ssh_keys = self.app_ssh_keys.map{|k| k.attributes} d_ssh_keys = get_updated_ssh_keys(nil, self.domain.system_ssh_keys) o_ssh_keys = get_updated_ssh_keys(self.domain.owner._id, self.domain.owner.ssh_keys) u_ssh_keys = CloudUser.find(self.domain.user_ids).map{|u| get_updated_ssh_keys(u._id, u.ssh_keys)}.flatten ssh_keys = a_ssh_keys + d_ssh_keys + o_ssh_keys + u_ssh_keys env_vars = self.domain.env_vars init_git_url = nil unless hosts_app_dns gear_id_prereqs = {} gear_ids.each do |gear_id| host_singletons = (gear_id == singleton_gear_id) app_dns = (host_singletons && hosts_app_dns) init_gear_op = PendingAppOp.new(op_type: :init_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "host_singletons" => host_singletons, "app_dns" => app_dns}) init_gear_op.prereq = [ginst_op_id] unless ginst_op_id.nil? reserve_uid_op = PendingAppOp.new(op_type: :reserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [init_gear_op._id.to_s]) create_gear_op = PendingAppOp.new(op_type: :create_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [reserve_uid_op._id.to_s], retry_rollback_op: reserve_uid_op._id.to_s) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage], "gear_size" => gear_size}, prereq: [create_gear_op._id.to_s]) register_dns_op = PendingAppOp.new(op_type: :register_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [create_gear_op._id.to_s]) pending_ops.push(init_gear_op) pending_ops.push(reserve_uid_op) pending_ops.push(create_gear_op) pending_ops.push(track_usage_op) pending_ops.push(register_dns_op) if additional_filesystem_gb != 0 fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id, "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [create_gear_op._id.to_s], saved_values: {"additional_filesystem_gb" => 0}) pending_ops.push(fs_op) track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end gear_id_prereqs[gear_id] = register_dns_op._id.to_s end ops = calculate_update_new_configuration_ops({"add_keys_attrs" => ssh_keys, "add_env_vars" => env_vars}, ginst_id, gear_id_prereqs) pending_ops.push(*ops) ops = calculate_add_component_ops(comp_specs, ginst_id, gear_id_prereqs, singleton_gear_id, component_ops, is_scale_up, ginst_op_id, init_git_url) pending_ops.push(*ops) pending_ops end |
- (Object) calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb)
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 |
# File 'origin-server/controller/app/models/application.rb', line 1449 def calculate_gear_destroy_ops(ginst_id, gear_ids, additional_filesystem_gb) pending_ops = [] delete_gear_op = nil gear_ids.each do |gear_id| destroy_gear_op = PendingAppOp.new(op_type: :destroy_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}) deregister_dns_op = PendingAppOp.new(op_type: :deregister_dns, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [destroy_gear_op._id.to_s]) unreserve_uid_op = PendingAppOp.new(op_type: :unreserve_uid, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [deregister_dns_op._id.to_s]) delete_gear_op = PendingAppOp.new(op_type: :delete_gear, args: {"group_instance_id"=> ginst_id, "gear_id" => gear_id}, prereq: [unreserve_uid_op._id.to_s]) track_usage_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:gear_usage]}, prereq: [delete_gear_op._id.to_s]) ops = [destroy_gear_op, deregister_dns_op, unreserve_uid_op, delete_gear_op, track_usage_op] pending_ops.push *ops if additional_filesystem_gb != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => additional_filesystem_gb}, prereq: [delete_gear_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end comp_specs = self.group_instances.find(ginst_id).all_component_instances.map{ |c| c.to_hash } comp_specs.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) gear_ids.each do |gear_id| pending_ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear_id, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [delete_gear_op._id.to_s])) end if cartridge.is_premium? end pending_ops end |
- (Object) calculate_ops(changes, moves = [], connections = nil, group_overrides = nil, init_git_url = nil)
Given a set of changes, moves and connections, calculates all the operations required to update the application.
Parameters:
| changes: | Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes). (Output of #compute_diffs or #scale_by) |
| moves: | A list of components which need to move from one group instance to another. (Output of #compute_diffs) |
| connections: | An array of connections. (Output of #elaborate) |
1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 |
# File 'origin-server/controller/app/models/application.rb', line 1663 def calculate_ops(changes,moves=[],connections=nil,group_overrides=nil,init_git_url=nil) app_dns_ginst_found = false add_gears = 0 remove_gears = 0 pending_ops = [] start_order, stop_order = calculate_component_orders unless group_overrides.nil? set_group_override_op = PendingAppOp.new(op_type: :set_group_overrides, args: {"group_overrides"=> group_overrides}, saved_values: {"group_overrides" => self.group_overrides}) pending_ops.push set_group_override_op end component_ops = {} # Create group instances and gears in preparation for move or add component operations create_ginst_changes = changes.select{ |change| change[:from].nil? } create_ginst_changes.each do |change| ginst_scale = change[:to_scale][:current] || 1 ginst_id = change[:to] gear_size = change[:to_scale][:gear_size] || self.default_gear_size additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] || 0 add_gears += ginst_scale if ginst_scale > 0 ginst_op = PendingAppOp.new(op_type: :create_group_instance, args: {"group_instance_id"=> ginst_id}) ginst_op.prereq << set_group_override_op._id.to_s unless set_group_override_op.nil? pending_ops.push(ginst_op) gear_ids = (1..ginst_scale).map {|idx| Moped::BSON::ObjectId.new.to_s} comp_specs = change[:added] app_dns_ginst = false comp_specs.each do |comp_spec| cats = CartridgeCache.find_cartridge(comp_spec["cart"], self).categories app_dns_ginst = true if ((not self.scalable) and cats.include?("web_framework")) || cats.include?("web_proxy") end if app_dns_ginst singleton_gear_id = gear_ids[0] = self._id.to_s else singleton_gear_id = gear_ids[0] end ops = calculate_gear_create_ops(ginst_id, gear_ids, singleton_gear_id, comp_specs, component_ops, additional_filesystem_gb, gear_size, ginst_op._id.to_s, false, app_dns_ginst,init_git_url) pending_ops.push *ops end moves.each do |move| #ops.push(PendingAppOps.new(op_type: :move_component, args: move, flag_req_change: true)) end changes.each do |change| unless change[:from].nil? group_instance = self.group_instances.find(change[:from]) if change[:to].nil? remove_gears += change[:from_scale][:current] group_instance_remove_ops = calculate_remove_group_instance_ops(change[:removed], group_instance) pending_ops.push(*group_instance_remove_ops) else scale_change = 0 if change[:to_scale][:current].nil? if change[:from_scale][:current] < change[:to_scale][:min] scale_change += change[:to_scale][:min] - change[:from_scale][:current] end if((change[:from_scale][:current] > change[:to_scale][:max]) && (change[:to_scale][:max] != -1)) scale_change -= change[:from_scale][:current] - change[:to_scale][:max] end else scale_change += (change[:to_scale][:current] - change[:from_scale][:current]) end singleton_gear = group_instance.gears.find_by(host_singletons: true) ops = calculate_remove_component_ops(change[:removed], group_instance, singleton_gear) pending_ops.push(*ops) gear_id_prereqs = {} group_instance.gears.each{|g| gear_id_prereqs[g._id.to_s] = []} ops = calculate_add_component_ops(change[:added], change[:from], gear_id_prereqs, singleton_gear._id.to_s, component_ops, false, nil) pending_ops.push(*ops) changed_additional_filesystem_gb = nil #add/remove fs space from existing gears if change[:from_scale][:additional_filesystem_gb] != change[:to_scale][:additional_filesystem_gb] changed_additional_filesystem_gb = change[:to_scale][:additional_filesystem_gb] usage_prereq = [] usage_prereq = [pending_ops.last._id.to_s] if pending_ops.last usage_ops = [] if change[:from_scale][:additional_filesystem_gb] != 0 group_instance.gears.each do |gear| track_usage_old_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: usage_prereq) usage_ops.push(track_usage_old_fs_op._id.to_s) pending_ops.push(track_usage_old_fs_op) end end group_instance.gears.each do |gear| fs_op = PendingAppOp.new(op_type: :set_gear_additional_filesystem_gb, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id.to_s, "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, saved_values: {"additional_filesystem_gb" => change[:from_scale][:additional_filesystem_gb]}, prereq: (usage_ops.empty?? usage_prereq : usage_ops)) pending_ops.push(fs_op) if change[:to_scale][:additional_filesystem_gb] != 0 track_usage_fs_op = PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:begin], "usage_type" => UsageRecord::USAGE_TYPES[:addtl_fs_gb], "additional_filesystem_gb" => change[:to_scale][:additional_filesystem_gb]}, prereq: [fs_op._id.to_s]) pending_ops.push(track_usage_fs_op) end end end if scale_change > 0 add_gears += scale_change comp_specs = self.component_instances.where(group_instance_id: group_instance._id).map{|c| c.to_hash} singleton_gear = group_instance.gears.find_by(host_singletons: true) gear_ids = (1..scale_change).map {|idx| Moped::BSON::ObjectId.new.to_s} additional_filesystem_gb = changed_additional_filesystem_gb || group_instance.addtl_fs_gb gear_size = change[:to_scale][:gear_size] || group_instance.gear_size ops = calculate_gear_create_ops(change[:from], gear_ids, singleton_gear._id.to_s, comp_specs, component_ops, additional_filesystem_gb, gear_size, nil, true) pending_ops.push *ops end if scale_change < 0 remove_gears += -scale_change ginst = self.group_instances.find(change[:from]) scaled_gears = ginst.gears.select { |g| g.app_dns==false } gears = scaled_gears[(scaled_gears.length + scale_change)..-1] remove_ids = gears.map{|g| g._id.to_s} ops = calculate_gear_destroy_ops(ginst._id.to_s, remove_ids, ginst.addtl_fs_gb) pending_ops.push(*ops) end end end end config_order = calculate_configure_order(component_ops.keys) config_order.each_index do |idx| next if idx == 0 prereq_ids = component_ops[config_order[idx-1]][:adds].map{|op| op._id.to_s} prereq_ids += component_ops[config_order[idx-1]][:post_configures].map{|op| op._id.to_s} component_ops[config_order[idx]][:new_component].prereq += prereq_ids unless component_ops[config_order[idx]][:new_component].nil? component_ops[config_order[idx]][:adds].each { |op| op.prereq += prereq_ids } component_ops[config_order[idx]][:post_configures].each { |op| op.prereq += prereq_ids } end execute_connection_op = nil all_ops_ids = pending_ops.map{ |op| op._id.to_s } execute_connection_op = PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) pending_ops.push execute_connection_op # check to see if there are any deployable carts being configured # if so, then make sure that the post-configure op for it is executed at the end # also, it should not be the prerequisite for any other pending_op component_ops.keys.each do |comp_spec| cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if cartridge.is_deployable? component_ops[comp_spec][:post_configures].each do |pcop| pcop.prereq += [execute_connection_op._id.to_s] pending_ops.each { |op| op.prereq.delete_if { |prereq_id| prereq_id == pcop._id.to_s } } end end end [pending_ops, add_gears, remove_gears] end |
- (Object) calculate_remove_component_ops(comp_specs, group_instance, singleton_gear)
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 |
# File 'origin-server/controller/app/models/application.rb', line 1614 def calculate_remove_component_ops(comp_specs, group_instance, singleton_gear) ops = [] comp_specs.each do |comp_spec| component_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) cartridge = CartridgeCache.find_cartridge(comp_spec["cart"], self) if component_instance.is_plugin? || (!self.scalable && component_instance.) if component_instance.is_singleton? op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => singleton_gear._id.to_s, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => singleton_gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? else group_instance.gears.each do |gear| op = PendingAppOp.new(op_type: :remove_component, args: {"group_instance_id"=> group_instance._id.to_s, "gear_id" => gear._id, "comp_spec" => comp_spec}) ops.push op ops.push(PendingAppOp.new(op_type: :track_usage, args: {"user_id" => self.domain.owner._id, "parent_user_id" => self.domain.owner.parent_user_id, "app_name" => self.name, "gear_ref" => gear._id.to_s, "event" => UsageRecord::EVENTS[:end], "usage_type" => UsageRecord::USAGE_TYPES[:premium_cart], "cart_name" => comp_spec["cart"]}, prereq: [op._id.to_s])) if cartridge.is_premium? end end end remove_ssh_keys = self.app_ssh_keys.find_by(component_id: component_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(component_instance._id) domain.remove_env_variables(component_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: ops.map{|o| o._id.to_s}) ops.push op ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(component_instance)}, prereq: [op._id.to_s])) end ops end |
- (Object) calculate_remove_gear_ops(args, prereqs = {})
1278 1279 1280 1281 1282 1283 1284 1285 1286 |
# File 'origin-server/controller/app/models/application.rb', line 1278 def calculate_remove_gear_ops(args, prereqs={}) gear_id = args["gear_id"] group_instance = (self.group_instances.select { |gi| (gi.gears.select { |g| g._id.to_s == gear_id.to_s }).length > 0 }).first return [] if group_instance.nil? ops = calculate_gear_destroy_ops(group_instance._id.to_s, [gear_id], group_instance.addtl_fs_gb) all_ops_ids = ops.map{ |op| op._id.to_s } ops.push PendingAppOp.new(op_type: :execute_connections, prereq: all_ops_ids) ops end |
- (Object) calculate_remove_group_instance_ops(comp_specs, group_instance)
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 |
# File 'origin-server/controller/app/models/application.rb', line 1363 def calculate_remove_group_instance_ops(comp_specs, group_instance) pending_ops = [] gear_destroy_ops = calculate_gear_destroy_ops(group_instance._id.to_s, group_instance.gears.map{|g| g._id.to_s}, group_instance.addtl_fs_gb) pending_ops.push(*gear_destroy_ops) gear_destroy_op_ids = gear_destroy_ops.map{|op| op._id.to_s} delete_comp_ops = [] unsubscribe_conn_ops = [] comp_specs.each do |comp_spec| comp_instance = self.component_instances.find_by(cartridge_name: comp_spec["cart"], component_name: comp_spec["comp"]) remove_ssh_keys = self.app_ssh_keys.find_by(component_id: comp_instance._id) rescue [] remove_ssh_keys = [remove_ssh_keys].flatten if remove_ssh_keys.length > 0 keys_attrs = remove_ssh_keys.map{|k| k.attributes.dup} pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pullAll" => { app_ssh_keys: keys_attrs }}) end domain.remove_system_ssh_keys(comp_instance._id) domain.remove_env_variables(comp_instance._id) op = PendingAppOp.new(op_type: :del_component, args: {"group_instance_id"=> group_instance._id.to_s, "comp_spec" => comp_spec}, prereq: gear_destroy_op_ids) delete_comp_ops.push op unsubscribe_conn_ops.push(PendingAppOp.new(op_type: :unsubscribe_connections, args: {"sub_pub_info" => get_unsubscribe_info(comp_instance)}, prereq: [op._id.to_s])) end pending_ops.push(*delete_comp_ops) pending_ops.push(*unsubscribe_conn_ops) comp_delete_op_ids = delete_comp_ops.map{|op| op._id.to_s} destroy_ginst_op = PendingAppOp.new(op_type: :destroy_group_instance, args: {"group_instance_id"=> group_instance._id.to_s}, prereq: gear_destroy_op_ids + comp_delete_op_ids) pending_ops.push(destroy_ginst_op) pending_ops end |
- (Object) calculate_replace_all_ssh_keys_ops(args)
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 |
# File 'origin-server/controller/app/models/application.rb', line 1328 def calculate_replace_all_ssh_keys_ops(args) ops = [] if (args.has_key?("keys_attrs")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :replace_all_ssh_keys, args: args.dup, prereq: [])) end end end ops end |
- (Object) calculate_scale_by(ginst_id, scale_by)
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 |
# File 'origin-server/controller/app/models/application.rb', line 1343 def calculate_scale_by(ginst_id, scale_by) changes = [] current_group_instances = group_instances_with_scale current_group_instances.each do |ginst| if ginst._id.to_s == ginst_id.to_s final_scale = ginst.gears.length + scale_by final_scale = ginst.min if final_scale < ginst.min final_scale = ginst.max if ((final_scale > ginst.max) && (ginst.max != -1)) changes << { :from=>ginst_id.to_s, :to=>ginst_id.to_s, :added=>[], :removed=>[], :from_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>ginst.gears.length}, :to_scale=>{:min=>ginst.min, :max=>ginst.max, :current=>final_scale} } end end calculate_ops(changes) end |
- (Object) calculate_update_existing_configuration_ops(args, prereqs = {})
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 |
# File 'origin-server/controller/app/models/application.rb', line 1298 def calculate_update_existing_configuration_ops(args, prereqs={}) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| prereq = prereqs[gear._id.to_s].nil? ? [] : [prereqs[gear._id.to_s]] args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end end ops end |
- (Object) calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs)
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 |
# File 'origin-server/controller/app/models/application.rb', line 1314 def calculate_update_new_configuration_ops(args, group_instance_id, gear_id_prereqs) ops = [] if (args.has_key?("add_keys_attrs") or args.has_key?("remove_keys_attrs") or args.has_key?("add_env_vars") or args.has_key?("remove_env_vars")) args["group_instance_id"] = group_instance_id gear_id_prereqs.each_key do |gear_id| args["gear_id"] = gear_id prereq = gear_id_prereqs[gear_id].nil? ? [] : [gear_id_prereqs[gear_id]] ops.push(PendingAppOp.new(op_type: :update_configuration, args: args.dup, prereq: prereq)) end end ops end |
- (Object) component_status(component_instance)
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 |
# File 'origin-server/controller/app/models/application.rb', line 822 def component_status(component_instance) #if cartridge_name.nil? # component_instance = self.component_instances.find(component_name: component_name) #else # component_instance = self.component_instances.find(component_name: component_name, cartridge_name: cartridge_name) #end result_io = ResultIO.new = [] GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| gear_output = gear.status(component_instance) += [{"gear_id" => gear._id.to_s, "message" => gear_output.resultIO.string}] r.append gear_output end end |
- (Object) compute_diffs(current_group_instances, new_group_instances)
Computes the changes (moves, additions, deletions) required to move from the current set of group instances/components to a new set.
Parameters:
| current_group_instances: | Group instance list containing information about current group instances.
Expected format:
|
| new_group_instances: | New set of group instances as computed by the elaborate function |
Returns:
| changes: | Changes needed to the current_group_instances to make it match the new_group_instances. (Includes all adds/removes) |
| moves: | A list of components which need to move from one group instance to another |
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 |
# File 'origin-server/controller/app/models/application.rb', line 1846 def compute_diffs(current_group_instances, new_group_instances) axis_size = current_group_instances.length + new_group_instances.length cost_matrix = Matrix.build(axis_size,axis_size){0} #compute cost of moves (0..axis_size-1).each do |from| (0..axis_size-1).each do |to| gi_from = current_group_instances[from].nil? ? [] : current_group_instances[from][:component_instances] gi_to = new_group_instances[to].nil? ? [] : new_group_instances[to][:component_instances] move_away = gi_from - gi_to move_in = gi_to - gi_from cost_matrix[from,to] = move_away.length + move_in.length end end #compute changes changes = [] (0..axis_size-1).each do |from| best_to = cost_matrix.row_vectors[from].to_a.index(cost_matrix.row_vectors[from].min) from_id = nil from_comp_insts = [] to_comp_insts = [] from_scale = {min: 1, max: MAX_SCALE, current: 0, additional_filesystem_gb: 0, gear_size: self.default_gear_size} to_scale = {min: 1, max: MAX_SCALE} unless current_group_instances[from].nil? from_comp_insts = current_group_instances[from][:component_instances] from_id = current_group_instances[from][:_id] from_scale = current_group_instances[from][:scale] end unless new_group_instances[best_to].nil? to_comp_insts = new_group_instances[best_to][:component_instances] to_scale = new_group_instances[best_to][:scale] to_id = from_id || new_group_instances[best_to][:_id] end unless from_comp_insts.empty? and to_comp_insts.empty? added = to_comp_insts - from_comp_insts removed = from_comp_insts - to_comp_insts changes << {from: from_id, to: to_id, added: added, removed: removed, from_scale: from_scale, to_scale: to_scale} end (0..axis_size-1).each {|i| cost_matrix[i,best_to] = 1000} end moves = [] changes.each do |c1| c1[:removed].each do |comp_spec| changes.each do |c2| if c2[:added].include?(comp_spec) from_id = c1[:from].nil? ? nil : c1[:from] to_id = c2[:to].nil? ? nil : c2[:to] moves << {component: comp_spec, from_group_instance_id: from_id, to_group_instance_id: to_id} c1[:removed].delete comp_spec c2[:added].delete comp_spec break end end end end [changes, moves] end |
- (ResultIO) destroy_app
#run_jobs must be called in order to perform the updates
Destroys all gears on the application. This operation will trigger deletion of any applications listed in #domain_requires
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 |
# File 'origin-server/controller/app/models/application.rb', line 538 def destroy_app self.domain.applications.each { |app| app.domain_requires.each { |app_id| if app_id==self._id # now we have to worry if apps have a circular dependency among them or not # assuming not for now or else stack overflow app.destroy_app break end } } self.remove_features(self.requires, [], true) Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :delete_app, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Object) elaborate(features, group_overrides = [])
Computes the group instances, component instances and connections required to support a given set of features
Parameters:
| feature: | A list of features |
| group_overrides: | A list of group-overrides which specify which components must be placed on the same group. Components can be specified as Hash<cart name> [, comp: <component name>] |
Returns:
| connections: | An array of connections |
| group instances: | An array of hash values representing a group instances. |
2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'origin-server/controller/app/models/application.rb', line 2061 def elaborate(features, group_overrides = []) profiles = [] added_cartridges = [] overrides = deep_copy(group_overrides) #calculate initial list based on user provided dependencies features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end #solve for transitive dependencies until added_cartridges.length == 0 do carts_to_process = added_cartridges added_cartridges = [] carts_to_process.each do |cart| cart.requires.each do |feature| next if profiles.count{|d| d[:cartridge].features.include?(feature)} > 0 cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UnfulfilledRequirementException.new(feature) if cart.nil? prof = cart.profile_for_feature(feature) added_cartridges << cart profiles << {cartridge: cart, profile: prof} end end end #calculate component instances component_instances = [] profiles.each do |data| data[:profile].components.each do |component| component_instances << { cartridge: data[:cartridge], component: component } end end #calculate connections publishers = {} connections = [] component_instances.each do |ci| ci[:component].publishes.each do |connector| type = connector.type name = connector.name publishers[type] = [] if publishers[type].nil? publishers[type] << { cartridge: ci[:cartridge].name , component: ci[:component].name, connector: name } end end component_instances.each do |ci| ci[:component].subscribes.each do |connector| stype = connector.type sname = connector.name if publishers.has_key? stype publishers[stype].each do |cinfo| connections << { "from_comp_inst" => {"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, "to_comp_inst" => {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}, "from_connector_name" => cinfo[:connector], "to_connector_name" => sname, "connection_type" => stype} if stype.starts_with?("FILESYSTEM") or stype.starts_with?("SHMEM") overrides << [{"cart"=> cinfo[:cartridge], "comp"=> cinfo[:component]}, {"cart"=> ci[:cartridge].name, "comp"=> ci[:component].name}] end end end end end comp_specs = component_instances.map{ |ci| {"comp"=> ci[:component].name, "cart"=> ci[:cartridge].name}} processed_overrides, cleaned_overrides = process_group_overrides(comp_specs, overrides) group_instances = processed_overrides.map{ |go| group_instance = {} group_instance[:component_instances] = go["components"] group_instance[:scale] = {} group_instance[:scale][:min] = ( go["min_gears"] || 1 ) group_instance[:scale][:max] = ( go["max_gears"] || -1 ) group_instance[:scale][:gear_size] = ( go["gear_size"] || self.default_gear_size ) group_instance[:scale][:additional_filesystem_gb] ||= 0 group_instance[:scale][:additional_filesystem_gb] += (go["additional_filesystem_gb"] || 0) group_instance[:_id] = Moped::BSON::ObjectId.new group_instance } [connections, group_instances, cleaned_overrides] end # Returns the configure order specified in the application descriptor or processes the configure # orders for each component and returns the final order (topological sort). # @note This is calculates separately from start/stop order as this function is usually used to # compute the {PendingAppOps} while start/stop order applies to already configured components. # # == Parameters: # comp_specs:: # Array of components specs to order. # # == Returns: # {ComponentInstance} objects ordered by calculated configure order def calculate_configure_order(comp_specs) configure_order = ComponentOrder.new comps = [] categories = {} comp_specs.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst["cart"], self) prof = cart.get_profile_for_component(comp_inst["comp"]) comps << {cart: cart, prof: prof} [[comp_inst["cart"]],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end configure_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| configure_order.add_component_order(comp_spec[:prof].configure_order.map{|c| categories[c]}.flatten) end #calculate configure order using tsort if self.component_configure_order.empty? computed_configure_order = configure_order.tsort else computed_configure_order = self.component_configure_order.map{|c| categories[c]}.flatten end # configure order can have nil if the component is already configured # for eg, phpmyadmin is being added and it is the only component being passed/added # this could happen if mysql is already previously configured computed_configure_order.select { |co| not co.nil? } end # Returns the start/stop order specified in the application descriptor or processes the start and stop # orders for each component and returns the final order (topological sort). # # == Returns: # start_order:: # {ComponentInstance} objects ordered by calculated start order # stop_order:: # {ComponentInstance} objects ordered by calculated stop order def calculate_component_orders start_order = ComponentOrder.new stop_order = ComponentOrder.new comps = [] categories = {} #build a map of [categories, features, cart name] => component_instance component_instances.each do |comp_inst| cart = CartridgeCache.find_cartridge(comp_inst.cartridge_name, self) prof = cart.get_profile_for_component(comp_inst.component_name) comps << {cart: cart, prof: prof} [[comp_inst.cartridge_name],cart.categories,cart.provides,prof.provides].flatten.each do |cat| categories[cat] = [] if categories[cat].nil? categories[cat] << comp_inst end start_order.add_component_order([comp_inst]) stop_order.add_component_order([comp_inst]) end #use the map to build DAG for order calculation comps.each do |comp_spec| start_order.add_component_order(comp_spec[:prof].start_order.map{|c| categories[c]}.flatten) stop_order.add_component_order(comp_spec[:prof].stop_order.map{|c| categories[c]}.flatten) end #calculate start order using tsort if self.component_start_order.empty? computed_start_order = start_order.tsort else computed_start_order = self.component_start_order.map{|c| categories[c]}.flatten end #calculate stop order using tsort if self.component_stop_order.empty? computed_stop_order = stop_order.tsort else computed_stop_order = self.component_stop_order.map{|c| categories[c]}.flatten end # start/stop order can have nil if the component is not present in the application # for eg, php is being stopped and haproxy is not present in a non-scalable application computed_start_order = computed_start_order.select { |co| not co.nil? } computed_stop_order = computed_stop_order.select { |co| not co.nil? } [computed_start_order, computed_stop_order] end # Gets a feature name for the cartridge/component combination # # == Parameters: # cartridge_name:: # Name of cartridge # component_name:: # Name of component # # == Returns: # Feature name provided by the cartridge that includes the component def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end # The ssh key names are used as part of the ssh key comments on the application's gears # Do not change the format of the key name, otherwise it may break key removal code on the node def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end # Get path for checking application health # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [String] def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end # Get scaling limits for the application's group instance that has the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return [Integer, Integer] def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end # Get the web framework cartridge # This method is only to maintain backwards compatibility for rest api version 1.0 # @return Cartridge def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end end |
- (Object) execute_connections
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 |
# File 'origin-server/controller/app/models/application.rb', line 993 def execute_connections if self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(self.requires, self.group_overrides) set_connections(connections) Rails.logger.debug "Running publishers" handle = RemoteJob.create_parallel_job #publishers sub_jobs = [] self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) pub_ginst = self.group_instances.find(pub_inst.group_instance_id) tag = conn._id.to_s pub_ginst.gears.each_index do |idx| break if (pub_inst.is_singleton? && idx > 0) gear = pub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid] job = gear.get_execute_connector_job(pub_inst, conn.from_connector_name, conn.connection_type, input_args) RemoteJob.add_parallel_job(handle, tag, gear, job) end end pub_out = {} RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| conn_type = self.connections.find { |c| c._id.to_s == tag}.connection_type if status==0 if conn_type.start_with?("ENV:") pub_out[tag] = {} if pub_out[tag].nil? pub_out[tag][gear_id] = output else pub_out[tag] = [] if pub_out[tag].nil? pub_out[tag].push("'#{gear_id}'='#{output}'") end end end Rails.logger.debug "Running subscribers" #subscribers handle = RemoteJob.create_parallel_job self.connections.each do |conn| pub_inst = self.component_instances.find(conn.from_comp_inst_id) sub_inst = self.component_instances.find(conn.to_comp_inst_id) sub_ginst = self.group_instances.find(sub_inst.group_instance_id) tag = "" unless pub_out[conn._id.to_s].nil? if conn.connection_type.start_with?("ENV:") input_to_subscriber = pub_out[conn._id.to_s] else input_to_subscriber = Shellwords::shellescape(pub_out[conn._id.to_s].join(' ')) end Rails.logger.debug "Output of publisher - '#{pub_out}'" sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] input_args = [gear.name, self.domain.namespace, gear.uuid, input_to_subscriber] job = gear.get_execute_connector_job(sub_inst, conn.to_connector_name, conn.connection_type, input_args, pub_inst.cartridge_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end end RemoteJob.execute_parallel_jobs(handle) Rails.logger.debug "Connections done" end end |
- (Object) extended_validator
Observer hook for extending the validation of the application in an ActiveRecord::Observer
126 127 128 |
# File 'origin-server/controller/app/models/application.rb', line 126 def extended_validator notify_observers(:validate_application) end |
- (ResultIO) fix_gear_ssh_keys
Removes all ssh keys from the application’s gears and adds the given ssh keys.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'origin-server/controller/app/models/application.rb', line 311 def fix_gear_ssh_keys() Application.run_in_application_lock(self) do ssh_keys = [] # reload the application to get the latest data self.with(consistency: :strong).reload # get the application keys ssh_keys |= self.app_ssh_keys.map {|k| k.to_key_hash} # get the domain ssh keys ssh_keys |= get_updated_ssh_keys(nil, self.domain.system_ssh_keys) # get the user ssh keys ssh_keys |= get_updated_ssh_keys(self.domain.owner_id, self.domain.owner.ssh_keys) op_group = PendingAppOpGroup.new(op_type: :replace_all_ssh_keys, args: {"keys_attrs" => ssh_keys}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (String) fqdn(domain = nil, gear_uuid = nil)
Returns the fully qualified DNS name for the primary application gear
622 623 624 625 626 |
# File 'origin-server/controller/app/models/application.rb', line 622 def fqdn(domain=nil, gear_uuid = nil) domain = domain || self.domain appname = gear_uuid || self.name "#{appname}-#{domain.namespace}.#{Rails.configuration.openshift[:domain_suffix]}" end |
- (Object) gen_non_scalable_app_overrides(features)
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 |
# File 'origin-server/controller/app/models/application.rb', line 2278 def gen_non_scalable_app_overrides(features) #find web_framework web_framework = {} features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) prof = prof.first if prof.is_a? Array comp = prof.components.first web_framework = {"cart"=>cart.name, "comp"=>comp.name} end group_overrides = [{"components"=>[web_framework], "max_gears"=> 1}] #generate group overrides to colocate all components with web_framework and limit scale to 1 features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next if cart.categories.include? "web_framework" prof = cart.profile_for_feature(feature) components = prof.components group_overrides += components.map { |comp| { "components" => [ web_framework, {"cart"=>cart.name, "comp"=>comp.name} ], "max_gears" => 1 } } end group_overrides end |
- (Integer) get_app_scaling_limits
Get scaling limits for the application’s group instance that has the web framework cartridge This method is only to maintain backwards compatibility for rest api version 1.0
2350 2351 2352 2353 2354 2355 |
# File 'origin-server/controller/app/models/application.rb', line 2350 def get_app_scaling_limits web_cart = get_framework_cartridge component_instance = self.component_instances.find_by(cartridge_name: web_cart.name) group_instance = group_instances_with_scale.select{ |go| go.all_component_instances.include? component_instance }[0] [group_instance.min, group_instance.max] end |
- (Object) get_components_for_feature(feature)
2271 2272 2273 2274 2275 2276 |
# File 'origin-server/controller/app/models/application.rb', line 2271 def get_components_for_feature(feature) cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("No cartridge found that provides #{feature}", 109) if cart.nil? prof = cart.profile_for_feature(feature) prof.components.map{ |comp| self.component_instances.find_by(cartridge_name: cart.name, component_name: comp.name) } end |
- (Object) get_feature(cartridge_name, component_name)
Gets a feature name for the cartridge/component combination
Parameters:
| cartridge_name: | Name of cartridge |
| component_name: | Name of component |
Returns:
Feature name provided by the cartridge that includes the component
2265 2266 2267 2268 2269 |
# File 'origin-server/controller/app/models/application.rb', line 2265 def get_feature(cartridge_name,component_name) cart = CartridgeCache.find_cartridge(cartridge_name, self) prof = cart.get_profile_for_component component_name (prof.provides.length > 0 && prof.name != cart.default_profile) ? prof.provides.first : cart.provides.first end |
- (Object) get_framework_cartridge
Get the web framework cartridge This method is only to maintain backwards compatibility for rest api version 1.0
2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 |
# File 'origin-server/controller/app/models/application.rb', line 2360 def get_framework_cartridge web_cart = nil self.requires.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) next unless cart.categories.include? "web_framework" web_cart = cart break end web_cart end |
- (Hash<String, String>) get_gear_states
Retrieves the gear state for all gears within the application.
647 648 649 |
# File 'origin-server/controller/app/models/application.rb', line 647 def get_gear_states Gear.get_gear_states(group_instances.map{|g| g.gears}.flatten) end |
- (Object) get_unsubscribe_info(comp_inst)
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 |
# File 'origin-server/controller/app/models/application.rb', line 944 def get_unsubscribe_info(comp_inst) old_features = self.requires + [comp_inst.cartridge_name] #[get_feature(comp_inst.cartridge_name, comp_inst.component_name)] old_connections, ignore, ignore = elaborate(old_features) sub_pub_hash = {} if self.scalable and old_connections old_connections.each do |old_conn| if (old_conn["from_comp_inst"]["cart"] == comp_inst.cartridge_name) and (old_conn["from_comp_inst"]["comp"] == comp_inst.component_name) to_cart_comp = old_conn["to_comp_inst"]["cart"] + old_conn["to_comp_inst"]["comp"] sub_pub_hash[to_cart_comp] = [old_conn["to_comp_inst"], old_conn["from_comp_inst"]] end end end sub_pub_hash end |
- (Object) get_updated_ssh_keys(user_id, keys)
The ssh key names are used as part of the ssh key comments on the application’s gears Do not change the format of the key name, otherwise it may break key removal code on the node
2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 |
# File 'origin-server/controller/app/models/application.rb', line 2313 def get_updated_ssh_keys(user_id, keys) updated_keys_attrs = keys.map { |key| key_attrs = deep_copy(key.to_key_hash) case key.class when UserSshKey key_attrs["name"] = user_id.to_s + "-" + key_attrs["name"] when SystemSshKey key_attrs["name"] = "domain-" + key_attrs["name"] when ApplicationSshKey key_attrs["name"] = "application-" + key_attrs["name"] end key_attrs } updated_keys_attrs end |
- (Array<GroupInstance>) group_instances_with_scale
Retrieve the list of GroupInstance objects along with min and max gear specifications from group overrides
377 378 379 380 381 382 383 384 |
# File 'origin-server/controller/app/models/application.rb', line 377 def group_instances_with_scale self.group_instances.map do |group_instance| override_spec = group_instance.get_group_override group_instance.min = override_spec["min_gears"] group_instance.max = override_spec["max_gears"] group_instance end end |
- (String) health_check_path
Get path for checking application health This method is only to maintain backwards compatibility for rest api version 1.0
2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 |
# File 'origin-server/controller/app/models/application.rb', line 2332 def health_check_path web_cart = get_framework_cartridge if web_cart.nil? page = 'health' elsif web_cart.categories.include? 'php' page = 'health_check.php' elsif web_cart.categories.include? 'zend' page = 'health_check.php' elsif web_cart.categories.include? 'perl' page = 'health_check.pl' else page = 'health' end end |
- (Object) merge_group_overrides(first, second)
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 |
# File 'origin-server/controller/app/models/application.rb', line 2018 def merge_group_overrides(first, second) return_go = { } framework_carts = CartridgeCache.cartridge_names("web_framework", self) first_has_web_framework = false first["components"].each do |components| if framework_carts.include?(components['cart']) first_has_web_framework = true break end end if first_has_web_framework return_go["components"] = (first["components"] + second["components"]).uniq else return_go["components"] = (second["components"] + first["components"]).uniq end return_go["min_gears"] = [first["min_gears"]||1, second["min_gears"]||1].max if first["min_gears"] or second["min_gears"] return_go["additional_filesystem_gb"] = [first["additional_filesystem_gb"]||0, second["additional_filesystem_gb"]||0].max if first["additional_filesystem_gb"] or second["additional_filesystem_gb"] fmax = (first["max_gears"].nil? or first["max_gears"]==-1) ? 10000 : first["max_gears"] smax = (second["max_gears"].nil? or second["max_gears"]==-1) ? 10000 : second["max_gears"] return_go["max_gears"] = [fmax,smax].min if first["max_gears"] or second["max_gears"] return_go["max_gears"] = -1 if return_go["max_gears"]==10000 fi = Rails.application.config.openshift[:gear_sizes].index(first["gear_size"]) || 0 si = Rails.application.config.openshift[:gear_sizes].index(second["gear_size"]) || 0 return_go["gear_size"] = Rails.application.config.openshift[:gear_sizes][[fi,si].max] if first["gear_size"] or second["gear_size"] return_go end |
- (Integer) num_gears
Returns the total number of gears currently used by this application
368 369 370 371 372 |
# File 'origin-server/controller/app/models/application.rb', line 368 def num_gears num = 0 group_instances.each { |g| num += g.gears.count} num end |
- (Object) op_type_to_comp_op_type(op_type)
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 |
# File 'origin-server/controller/app/models/application.rb', line 1597 def op_type_to_comp_op_type(op_type) comp_op_type = nil case op_type when :start_app, :start_feature comp_op_type = :start_component when :stop_app, :stop_feature comp_op_type = :stop_component when :restart_app, :restart_feature comp_op_type = :restart_component when :reload_app_config, :reload_feature_config comp_op_type = :reload_component_config when :tidy_app comp_op_type = :tidy_component end comp_op_type end |
- (Object) process_commands(result_io, component_id = nil)
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 |
# File 'origin-server/controller/app/models/application.rb', line 1069 def process_commands(result_io, component_id=nil) commands = result_io.cart_commands add_ssh_keys = [] remove_env_vars = [] domain_keys_to_add = [] domain_env_vars_to_add = [] commands.each do |command_item| case command_item[:command] when "SYSTEM_SSH_KEY_ADD" domain_keys_to_add.push(SystemSshKey.new(name: self.name, type: "ssh-rsa", content: command_item[:args][0], component_id: component_id)) when "APP_SSH_KEY_ADD" add_ssh_keys << ApplicationSshKey.new(name: command_item[:args][0], type: "ssh-rsa", content: command_item[:args][1], created_at: Time.now, component_id: component_id) when "APP_ENV_VAR_REMOVE" remove_env_vars.push({"key" => command_item[:args][0]}) when "ENV_VAR_ADD" domain_env_vars_to_add.push({"key" => command_item[:args][0], "value" => command_item[:args][1], "component_id" => component_id}) when "BROKER_KEY_ADD" iv, token = OpenShift::Auth::BrokerKey.new.generate_broker_key(self) pending_op = PendingAppOpGroup.new(op_type: :add_broker_auth_key, args: { "iv" => iv, "token" => token }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) when "BROKER_KEY_REMOVE" pending_op = PendingAppOpGroup.new(op_type: :remove_broker_auth_key, args: { }, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash } }) end end if add_ssh_keys.length > 0 keys_attrs = get_updated_ssh_keys(nil, add_ssh_keys) pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"add_keys_attrs" => keys_attrs}, user_agent: self.user_agent) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }, "$pushAll" => { app_ssh_keys: keys_attrs }}) end if remove_env_vars.length > 0 pending_op = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => remove_env_vars}) Application.where(_id: self._id).update_all({ "$push" => { pending_op_groups: pending_op.serializable_hash }}) end # Have to remember to run_jobs for the other apps involved at some point # run_jobs is called on the domain after all processing is done from add_features and remove_features domain.add_system_ssh_keys(domain_keys_to_add) if !domain_keys_to_add.empty? domain.add_env_variables(domain_env_vars_to_add) if !domain_env_vars_to_add.empty? nil end |
- (Object) process_group_overrides(component_instances, group_overrides)
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 |
# File 'origin-server/controller/app/models/application.rb', line 1955 def process_group_overrides(component_instances, group_overrides) overrides = group_overrides ? deep_copy(group_overrides) : [] cleaned_overrides = [] # Resolve additional group overrides from component_instances component_instances.each do |component_instance| cart = CartridgeCache.find_cartridge(component_instance["cart"], self) prof = cart.profile_for_feature(component_instance["comp"]) prof = prof[0] if prof.is_a?(Array) comp = prof.get_component(component_instance["comp"]) overrides += deep_copy(prof.group_overrides) component_go = {"components" => [{"cart" => cart.name, "comp" => comp.name}] } if !comp.is_singleton? component_go["min_gears"] = comp.scaling.min component_go["max_gears"] = comp.scaling.max end overrides << component_go end # Resolve all components within the group overrides # Remove deleted components from group_overrides and build cleaned_overrides array overrides.each do |group_override| cleaned_override = {} cleaned_override["components"] ||= [] group_override["components"].map! do |comp_spec| comp_spec = {"comp" => comp_spec} if comp_spec.class == String component = component_instances.select{|ci| ci["comp"] == comp_spec["comp"] && (comp_spec["cart"].nil? || ci["cart"] == comp_spec["cart"])} next if component.size == 0 component = component.first cleaned_override["components"] << component component end cleaned_override["min_gears"] = group_override["min_gears"] if group_override.has_key?("min_gears") cleaned_override["max_gears"] = group_override["max_gears"] if group_override.has_key?("max_gears") cleaned_override["additional_filesystem_gb"] = group_override["additional_filesystem_gb"] if group_override.has_key?("additional_filesystem_gb") cleaned_overrides << cleaned_override if group_override["components"] and group_override["components"].count > 0 end # work on cleaned_overrides only go_map = {} cleaned_overrides.each { |go| merged_go = deep_copy(go) go["components"].each { |comp| existing_go = go_map["#{comp["cart"]}/#{comp["comp"]}"] merged_go = merge_group_overrides(merged_go, existing_go) if existing_go } merged_go["components"].each { |comp| go_map["#{comp["cart"]}/#{comp["comp"]}"] = merged_go } } processed_group_overrides = [] component_instances.each { |ci| go = go_map["#{ci["cart"]}/#{ci["comp"]}"] next if go.nil? processed_group_overrides << deep_copy(go) if !processed_group_overrides.include? go } # processed_group_overrides = deep_copy(go_map.values.uniq) return [processed_group_overrides, processed_group_overrides] end |
- (Object) quarantined
189 190 191 192 193 194 195 196 197 198 |
# File 'origin-server/controller/app/models/application.rb', line 189 def quarantined group_instances.each do |gi| gi.gears.each do |gear| if gear.quarantined return true end end end false end |
- (Object) reload_component_config(component_name, cartridge_name)
775 776 777 778 779 780 781 782 783 |
# File 'origin-server/controller/app/models/application.rb', line 775 def reload_component_config(component_name, cartridge_name) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :reload_component_config, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Object) reload_config(feature = nil)
747 748 749 750 751 752 753 754 755 756 757 758 759 760 |
# File 'origin-server/controller/app/models/application.rb', line 747 def reload_config(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :reload_app_config, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :reload_feature_config, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) remove_alias(fqdn)
Removes a DNS alias for the application.
Parameters:
| fqdn: | Fully qualified domain name of the alias to remove from this application |
Returns:
PendingAppOps object which tracks the progress of the operation.
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 |
# File 'origin-server/controller/app/models/application.rb', line 892 def remove_alias(fqdn) fqdn = fqdn.downcase if fqdn al1as = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do if al1as.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end op_group = PendingAppOpGroup.new(op_type: :remove_alias, args: {"fqdn" => al1as.fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (ResultIO) remove_env_variables(vars, parent_op = nil)
Remove environment variables from all gears on the application.
355 356 357 358 359 360 361 362 363 |
# File 'origin-server/controller/app/models/application.rb', line 355 def remove_env_variables(vars, parent_op=nil) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_env_vars" => vars}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (ResultIO) remove_features(features, group_overrides = [], force = false)
Removes components from the application
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 |
# File 'origin-server/controller/app/models/application.rb', line 491 def remove_features(features, group_overrides=[], force=false) installed_features = self.requires result_io = ResultIO.new features.each do |feature| cart = CartridgeCache.find_cartridge(feature, self) raise OpenShift::UserException.new("Invalid feature: #{feature}", 109) unless cart Rails.logger.debug "Removing feature #{feature}" if !force raise OpenShift::UserException.new("'#{feature}' cannot be removed", 137) if (cart.is_web_proxy? and self.scalable) or cart.is_web_framework? raise OpenShift::UserException.new("'#{feature}' is not a feature of '#{self.name}'", 135) unless installed_features.include? feature end if cart.is_ci_server? self.domain.applications.each do |uapp| next if self.name == uapp.name uapp.requires.each do |feature_name| ucart = CartridgeCache.find_cartridge(feature_name, self) if ucart.is_ci_builder? Application.run_in_application_lock(uapp) do uapp.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => [feature_name], "group_overrides" => uapp.group_overrides}, user_agent: uapp.user_agent) uapp.run_jobs(result_io) end end end end end end Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_features, args: {"features" => features, "group_overrides" => group_overrides}, user_agent: self.user_agent) self.run_jobs(result_io) end # removing this feature may have caused pending_ops to be created on the domain # for removing env vars and ssh keys # execute run_jobs on the domain to take care of those domain.with(consistency: :strong).reload domain.run_jobs result_io end |
- (Object) remove_gear(gear_uuid)
800 801 802 803 804 805 806 807 808 809 |
# File 'origin-server/controller/app/models/application.rb', line 800 def remove_gear(gear_uuid) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable raise OpenShift::UserException.new("Gear for removal not specified") if gear_uuid.nil? Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :remove_gear, args: {"gear_id" => gear_uuid}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (ResultIO) remove_ssh_keys(user_id, keys, parent_op = nil)
Remove the given ssh key from the application. If multiple users share the same key, only the specified users key is removed but application access will still be possible.
294 295 296 297 298 299 300 301 302 303 304 |
# File 'origin-server/controller/app/models/application.rb', line 294 def remove_ssh_keys(user_id, keys, parent_op=nil) return if keys.empty? keys_attrs = get_updated_ssh_keys(user_id, keys) Application.run_in_application_lock(self) do op_group = PendingAppOpGroup.new(op_type: :update_configuration, args: {"remove_keys_attrs" => keys_attrs}, parent_op: parent_op, user_agent: self.user_agent) self.pending_op_groups.push op_group result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Array<String>) requires(include_pending = false)
Returns the feature requirements of the application
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'origin-server/controller/app/models/application.rb', line 390 def requires(include_pending=false) features = component_instances.map {|ci| ci.cartridge_name} #get_feature(ci.cartridge_name, ci.component_name)} if include_pending self.pending_op_groups.each do |op_group| case op_group.op_type when :add_features features += op_group[:args]["features"] when :remove_features features -= op_group[:args]["features"] end end end features || [] end |
- (Object) restart(feature = nil)
722 723 724 725 726 727 728 729 730 731 732 733 734 735 |
# File 'origin-server/controller/app/models/application.rb', line 722 def restart(feature=nil) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :restart_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :restart_feature, args: {"feature" => feature}, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) restart_component(component_name, cartridge_name)
737 738 739 740 741 742 743 744 745 |
# File 'origin-server/controller/app/models/application.rb', line 737 def restart_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :restart_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) run_jobs(result_io = nil)
Acquires an application level lock and runs all pending jobs and stops at the first failure.
Returns:
True on success or False if unable to acquire the lock or no pending jobs.
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 |
# File 'origin-server/controller/app/models/application.rb', line 1120 def run_jobs(result_io=nil) result_io = ResultIO.new if result_io.nil? self.with(consistency: :strong).reload return true if (self.pending_op_groups.count == 0) begin while self.pending_op_groups.count > 0 op_group = self.pending_op_groups.first self.user_agent = op_group.user_agent op_group.pending_ops if op_group.pending_ops.count == 0 case op_group.op_type when :update_configuration ops = calculate_update_existing_configuration_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_features #need rollback features = self.requires + op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides, op_group.args["init_git_url"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :remove_features #need rollback features = self.requires - op_group.args["features"] group_overrides = (self.group_overrides || []) + (op_group.args["group_overrides"] || []) ops, add_gear_count, rm_gear_count = update_requirements(features, group_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :update_component_limits updated_overrides = deep_copy(self.group_overrides || []) found = updated_overrides.find {|go| go["components"].include? op_group.args["comp_spec"] } group_override = found || {"components" => [op_group.args["comp_spec"]]} group_override["min_gears"] = op_group.args["min"] unless op_group.args["min"].nil? group_override["max_gears"] = op_group.args["max"] unless op_group.args["max"].nil? group_override["additional_filesystem_gb"] = op_group.args["additional_filesystem_gb"] unless op_group.args["additional_filesystem_gb"].nil? updated_overrides.push(group_override) unless found features = self.requires ops, add_gear_count, rm_gear_count = update_requirements(features, updated_overrides) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :delete_app self.pending_op_groups.clear self.delete when :remove_gear ops = calculate_remove_gear_ops(op_group.args) try_reserve_gears(0, 1, op_group, ops) when :scale_by #need rollback ops, add_gear_count, rm_gear_count = calculate_scale_by(op_group.args["group_instance_id"], op_group.args["scale_by"]) try_reserve_gears(add_gear_count, rm_gear_count, op_group, ops) when :replace_all_ssh_keys ops = calculate_replace_all_ssh_keys_ops(op_group.args) op_group.pending_ops.push(*ops) when :add_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :remove_alias self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_alias, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :add_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"], "ssl_certificate" => op_group.args["ssl_certificate"], "private_key" => op_group.args["private_key"], "pass_phrase" => op_group.args["pass_phrase"] } ) break end end when :remove_ssl_cert self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) op_group.pending_ops.push PendingAppOp.new(op_type: :remove_ssl_cert, args: {"group_instance_id" => group_instance.id.to_s, "gear_id" => gear.id.to_s, "fqdn" => op_group.args["fqdn"]} ) break end end when :add_broker_auth_key, :remove_broker_auth_key ops = [] args = op_group.args.dup self.group_instances.each do |group_instance| args["group_instance_id"] = group_instance._id.to_s group_instance.gears.each do |gear| args["gear_id"] = gear._id.to_s ops.push(PendingAppOp.new(op_type: op_group.op_type, args: args.dup)) end end op_group.pending_ops.push(*ops) when :start_app, :stop_app, :restart_app, :reload_app_config, :tidy_app ops = calculate_ctl_app_component_ops(op_group.op_type) op_group.pending_ops.push(*ops) when :start_feature, :stop_feature, :restart_feature, :reload_feature_config ops = calculate_ctl_feature_component_ops(op_group.op_type, op_group.args['feature']) op_group.pending_ops.push(*ops) when :start_component, :stop_component, :restart_component, :reload_component_config ops = calculate_ctl_component_ops(op_group.op_type, op_group.args['comp_spec']) op_group.pending_ops.push(*ops) end end if op_group.op_type != :delete_app op_group.execute(result_io) unreserve_gears(op_group.num_gears_removed) op_group.delete self.with(consistency: :strong).reload end end true rescue Exception => e_orig Rails.logger.error e_orig. Rails.logger.debug e_orig.backtrace.inspect #rollback begin op_group.execute_rollback(result_io) op_group.delete rescue Exception => e_rollback Rails.logger.error "Error during rollback" Rails.logger.error e_rollback. Rails.logger.error e_rollback.backtrace.inspect ensure num_gears_recovered = op_group.num_gears_added - op_group.num_gears_created + op_group.num_gears_rolled_back + op_group.num_gears_destroyed unreserve_gears(num_gears_recovered) end raise e_orig end end |
- (ResultIO) scale_by(group_instance_id, scale_by)
Trigger a scale up or scale down of a GroupInstance
604 605 606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'origin-server/controller/app/models/application.rb', line 604 def scale_by(group_instance_id, scale_by) raise OpenShift::UserException.new("Application #{self.name} is not scalable") if !self.scalable ginst = group_instances_with_scale.select {|gi| gi._id == group_instance_id}.first raise OpenShift::UserException.new("Cannot scale below minimum gear requirements.", 168) if scale_by < 0 && ginst.gears.length <= ginst.min raise OpenShift::UserException.new("Cannot scale up beyond maximum gear limit in app #{self.name}.", 168) if scale_by > 0 && ginst.gears.length >= ginst.max and ginst.max > 0 Application.run_in_application_lock(self) do self.pending_op_groups.push PendingAppOpGroup.new(op_type: :scale_by, args: {"group_instance_id" => group_instance_id, "scale_by" => scale_by}, user_agent: self.user_agent) result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Object) set_connections(connections)
932 933 934 935 936 937 938 939 940 941 942 |
# File 'origin-server/controller/app/models/application.rb', line 932 def set_connections(connections) conns = [] self.connections = [] if connections.nil? or connections.empty? connections.each do |conn_info| from_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["from_comp_inst"]["cart"], component_name: conn_info["from_comp_inst"]["comp"]) to_comp_inst = self.component_instances.find_by(cartridge_name: conn_info["to_comp_inst"]["cart"], component_name: conn_info["to_comp_inst"]["comp"]) conns.push(ConnectionInstance.new(from_comp_inst._id, to_comp_inst._id, conn_info["from_connector_name"], conn_info["to_connector_name"], conn_info["connection_type"])) end self.connections = conns end |
- (ResultIO) set_group_overrides(group_overrides)
Updates the component grouping overrides of the application and create tasks to perform the update
562 563 564 565 566 567 568 569 570 571 |
# File 'origin-server/controller/app/models/application.rb', line 562 def set_group_overrides(group_overrides) Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :add_features, args: {"features" => [], "group_overrides" => group_overrides}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Object) show_port
795 796 797 798 |
# File 'origin-server/controller/app/models/application.rb', line 795 def show_port #TODO raise "noimpl" end |
- (String) ssh_uri(domain = nil, gear_uuid = nil)
Returns the SSH URI for the primary application gear
631 632 633 634 635 636 637 638 639 640 641 642 |
# File 'origin-server/controller/app/models/application.rb', line 631 def ssh_uri(domain=nil, gear_uuid=nil) #if gear_uuid provided return "#{gear_uuid}@#{fqdn(domain,gear_uuid)}" if gear_uuid # else get the gear_uuid of head gear self.group_instances.each do |group_instance| if group_instance.gears.where(app_dns: true).count > 0 gear = group_instance.gears.find_by(app_dns: true) return "#{gear.uuid}@#{fqdn(domain)}" end end "" end |
- (ResultIO) start(feature = nil)
Start an application of feature
672 673 674 675 676 677 678 679 680 681 682 683 684 685 |
# File 'origin-server/controller/app/models/application.rb', line 672 def start(feature=nil) result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :start_app, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :start_feature, args: {"feature" => feature}, user_agent: self.user_agent) end Application.run_in_application_lock(self) do self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) start_component(component_name, cartridge_name)
687 688 689 690 691 692 693 694 695 |
# File 'origin-server/controller/app/models/application.rb', line 687 def start_component(component_name, cartridge_name) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :start_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) status(feature = nil)
811 812 813 814 815 816 817 818 819 820 |
# File 'origin-server/controller/app/models/application.rb', line 811 def status(feature=nil) result_io = ResultIO.new component_instances = get_components_for_feature(feature) component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.status(component_instance) end end result_io end |
- (Object) stop(feature = nil, force = false)
697 698 699 700 701 702 703 704 705 706 707 708 709 710 |
# File 'origin-server/controller/app/models/application.rb', line 697 def stop(feature=nil, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = nil if feature.nil? op_group = PendingAppOpGroup.new(op_type: :stop_app, args: { "force" => force }, user_agent: self.user_agent) else op_group = PendingAppOpGroup.new(op_type: :stop_feature, args: {"feature" => feature, "force" => force }, user_agent: self.user_agent) end self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) stop_component(component_name, cartridge_name, force = false)
712 713 714 715 716 717 718 719 720 |
# File 'origin-server/controller/app/models/application.rb', line 712 def stop_component(component_name, cartridge_name, force=false) Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :stop_component, args: {"comp_spec" => {"comp" => component_name, "cart" => cartridge_name}, "force" => force}, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) threaddump
762 763 764 765 766 767 768 769 770 771 772 773 |
# File 'origin-server/controller/app/models/application.rb', line 762 def threaddump threaddump_available = false result_io = ResultIO.new component_instances.each do |component_instance| GroupInstance.run_on_gears(component_instance.group_instance.gears, result_io, false) do |gear, r| r.append gear.threaddump(component_instance.cartridge_name) threaddump_available = true end if component_instance.get_additional_control_actions and component_instance.get_additional_control_actions.include? "threaddump" end raise OpenShift::UserException.new("The threaddump command is not available for this application", 180) if !threaddump_available result_io end |
- (Object) tidy
785 786 787 788 789 790 791 792 793 |
# File 'origin-server/controller/app/models/application.rb', line 785 def tidy Application.run_in_application_lock(self) do result_io = ResultIO.new op_group = PendingAppOpGroup.new(op_type: :tidy_app, user_agent: self.user_agent) self.pending_op_groups.push op_group self.run_jobs(result_io) result_io end end |
- (Object) to_descriptor
Returns the application descriptor as a Hash. The descriptor contains all the metadata necessary to descript the application.
655 656 657 658 659 660 661 662 663 664 665 666 |
# File 'origin-server/controller/app/models/application.rb', line 655 def to_descriptor h = { "Name" => self.name, "Requires" => self.requires(true) } h["Start-Order"] = @start_order unless @start_order.nil? || @start_order.empty? h["Stop-Order"] = @stop_order unless @stop_order.nil? || @stop_order.empty? h["Group-Overrides"] = self.group_overrides unless self.group_overrides.empty? h end |
- (Object) try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops)
Persists change operation only if the additional number of gears requested are available on the domain owner
Parameters:
| num_gears: | Number of gears to add or remove |
| ops: | Array of pending operations. @see PendingAppOps |
1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 |
# File 'origin-server/controller/app/models/application.rb', line 1918 def try_reserve_gears(num_gears_added, num_gears_removed, op_group, ops) owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner_capabilities = owner.get_capabilities if owner.consumed_gears + num_gears_added > owner_capabilities["max_gears"] and num_gears_added > 0 raise OpenShift::GearLimitReachedException.new("#{owner.login} is currently using #{owner.consumed_gears} out of #{owner_capabilities["max_gears"]} limit and this application requires #{num_gears_added} additional gears.") end owner.consumed_gears += num_gears_added op_group.pending_ops.push ops op_group.num_gears_added = num_gears_added op_group.num_gears_removed = num_gears_removed op_group.save owner.save ensure Lock.unlock_user(owner, self) end end |
- (Object) unreserve_gears(num_gears_removed)
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 |
# File 'origin-server/controller/app/models/application.rb', line 1940 def unreserve_gears(num_gears_removed) return if num_gears_removed == 0 owner = self.domain.owner begin until Lock.lock_user(owner, self) sleep 1 end owner.with(consistency: :strong).reload owner.consumed_gears -= num_gears_removed owner.save ensure Lock.unlock_user(owner, self) end end |
- (Object) unsubscribe_connections(sub_pub_hash)
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 |
# File 'origin-server/controller/app/models/application.rb', line 960 def unsubscribe_connections(sub_pub_hash) if self.scalable and sub_pub_hash Rails.logger.debug "Running unsubscribe connections" handle = RemoteJob.create_parallel_job sub_pub_hash.values.each do |to, from| sub_inst = nil begin sub_inst = self.component_instances.find_by(cartridge_name: to["cart"], component_name: to["comp"]) rescue Mongoid::Errors::DocumentNotFound #ignore end next if sub_inst.nil? sub_ginst = self.group_instances.find(sub_inst.group_instance_id) pub_cart_name = from["cart"] tag = sub_inst._id.to_s sub_ginst.gears.each_index do |idx| break if (sub_inst.is_singleton? && idx > 0) gear = sub_ginst.gears[idx] job = gear.get_unsubscribe_job(sub_inst, pub_cart_name) RemoteJob.add_parallel_job(handle, tag, gear, job) end end RemoteJob.execute_parallel_jobs(handle) RemoteJob.get_parallel_run_results(handle) do |tag, gear_id, output, status| if status != 0 Rails.logger.error "Unsubscribe Connection event failed:: tag: #{tag}, gear_id: #{gear_id},"\ "output: #{output}, status: #{status}" end end end end |
- (Object) update_alias(fqdn, ssl_certificate = nil, private_key = nil, pass_phrase = "")
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 |
# File 'origin-server/controller/app/models/application.rb', line 908 def update_alias(fqdn, ssl_certificate=nil, private_key=nil, pass_phrase="") validate_certificate(ssl_certificate, private_key, pass_phrase) fqdn = fqdn.downcase if fqdn old_alias = aliases.find_by(fqdn: fqdn) Application.run_in_application_lock(self) do #remove old certificate if old_alias.has_private_ssl_certificate op_group = PendingAppOpGroup.new(op_type: :remove_ssl_cert, args: {"fqdn" => fqdn}, user_agent: self.user_agent) self.pending_op_groups.push op_group end #add new certificate if ssl_certificate and !ssl_certificate.empty? op_group = PendingAppOpGroup.new(op_type: :add_ssl_cert, args: {"fqdn" => fqdn, "ssl_certificate" => ssl_certificate, "private_key" => private_key, "pass_phrase" => pass_phrase}, user_agent: self.user_agent) self.pending_op_groups.push op_group end result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (ResultIO) update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb)
Create and add group overrides to update scaling and filesystem limits for a the GroupInstance hosting a ComponentInstance
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 |
# File 'origin-server/controller/app/models/application.rb', line 581 def update_component_limits(component_instance, scale_from, scale_to, additional_filesystem_gb) if additional_filesystem_gb && additional_filesystem_gb != 0 max_storage = self.domain.owner.max_storage raise OpenShift::UserException.new("You are not allowed to request additional gear storage", 164) if max_storage == 0 raise OpenShift::UserException.new("You have requested more additional gear storage than you are allowed (max: #{max_storage} GB)", 166) if additional_filesystem_gb > max_storage end Application.run_in_application_lock(self) do pending_op = PendingAppOpGroup.new(op_type: :update_component_limits, args: {"comp_spec" => component_instance.to_hash, "min"=>scale_from, "max"=>scale_to, "additional_filesystem_gb"=>additional_filesystem_gb}, created_at: Time.new, user_agent: self.user_agent) pending_op_groups.push pending_op self.save result_io = ResultIO.new self.run_jobs(result_io) result_io end end |
- (Object) update_requirements(features, group_overrides, init_git_url = nil)
1288 1289 1290 1291 1292 1293 1294 1295 1296 |
# File 'origin-server/controller/app/models/application.rb', line 1288 def update_requirements(features, group_overrides, init_git_url=nil) group_overrides = (group_overrides + gen_non_scalable_app_overrides(features)).uniq unless self.scalable connections, new_group_instances, cleaned_group_overrides = elaborate(features, group_overrides) current_group_instance = self.group_instances.map { |gi| gi.to_hash } changes, moves = compute_diffs(current_group_instance, new_group_instances) calculate_ops(changes, moves, connections, cleaned_group_overrides,init_git_url) end |
- (Object) validate_certificate(ssl_certificate, private_key, pass_phrase)
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 |
# File 'origin-server/controller/app/models/application.rb', line 2371 def validate_certificate(ssl_certificate, private_key, pass_phrase) if ssl_certificate and !ssl_certificate.empty? raise OpenShift::UserException.new("Private key is required", 172, "private_key") if private_key.nil? #validate certificate begin ssl_cert_clean = OpenSSL::X509::Certificate.new(ssl_certificate.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid certificate: #{e.message}", 174, "ssl_certificate") end #validate private key begin pass_phrase = '' if pass_phrase.nil? priv_key_clean = OpenSSL::PKey.read(private_key.strip, pass_phrase.strip) rescue Exception => e raise OpenShift::UserException.new("Invalid private key or pass phrase: #{e.message}", 172, "private_key") end if not ssl_cert_clean.check_private_key(priv_key_clean) raise OpenShift::UserException.new("Private key/certificate mismatch", 172, "private_key") end if not [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA].include?(priv_key_clean.class) raise OpenShift::UserException.new("Key must be RSA or DSA for Apache mod_ssl",172, "private_key") end end end |